Use scala-cli in Getting Started page #3072

gkepka · 2024-09-16T08:28:52Z

No description provided.

bishabosha

I would propose that we assume the latest scala install which should be 3.5.0 - in which case scala-cli should be replaced by scala, as described in the release notes of 3.5.0 https://scala-lang.org/blog/2024/08/22/scala-3.5.0-released.html

_overviews/getting-started/index.md

sjrd · 2024-09-17T11:42:41Z

_overviews/getting-started/index.md

+* [The migration guide](/scala3/guides/migration/compatibility-intro.html) helps you to migrate your existing Scala 2 code base to Scala 3.
+
+The [Scala CLI documentation](https://scala-cli.virtuslab.org/) describes the available sub-commands and how to integrate the tool with an IDE of choice.
+
 ## Create a "Hello World" project with sbt


Looks like this section should be removed, or moved to a separate page.

sjrd · 2024-09-17T11:42:56Z

_overviews/getting-started/index.md

+def countFiles(): Unit =
+    val paths = os.list(os.pwd)
+    println(paths.length)


Suggested change

def countFiles(): Unit =

val paths = os.list(os.pwd)

println(paths.length)

def countFiles(): Unit =

val paths = os.list(os.pwd)

println(paths.length)

sjrd · 2024-09-17T11:44:03Z

_overviews/getting-started/index.md

@@ -145,6 +145,144 @@ To install them manually:
   or [AdoptOpenJDK 8/11](https://adoptopenjdk.net/). Refer to [JDK Compatibility](/overviews/jdk-compatibility/overview.html) for Scala/Java compatibility detail.
 1. Install [sbt](https://www.scala-sbt.org/download.html)

+## Using the Scala CLI
+
+Create a file named `hello.scala` with the following code:


Suggested change

Create a file named `hello.scala` with the following code:

In a directory of your choice, which we will call `<project-dir>`, create a file named `hello.scala` with the following code:

sjrd · 2024-09-17T11:44:46Z

_overviews/getting-started/index.md

+can be thought of as an analogue to the `void` keyword found in other languages. The `println` method will print the `"Hello, World!"`
+string to standard output.
+
+To run the program, execute `scala run hello.scala` command. The file will be compiled and executed, with console output


Suggested change

To run the program, execute `scala run hello.scala` command. The file will be compiled and executed, with console output

To run the program, execute `scala run hello.scala` command from a terminal, within the `<project-dir>` directory. The file will be compiled and executed, with console output

sjrd · 2024-09-17T11:45:21Z

_overviews/getting-started/index.md

+def countFiles(): Unit =
+    val paths = os.list(os.pwd)
+    println(paths.length)


Suggested change

def countFiles(): Unit =

val paths = os.list(os.pwd)

println(paths.length)

def countFiles(): Unit =

val paths = os.list(os.pwd)

println(paths.length)

sjrd · 2024-09-17T11:59:26Z

_overviews/getting-started/index.md

+The printed number should be 4: `hello.scala`, `counter.scala` and two hidden directories created automatically when a program is executed:
+`.bsp` containing information about project used by IDEs, and `.scala-build` containing the results of compilation.
+
+As it turns out, the `os-lib` library is a part of Scala Toolkit, a collection of libraries recommended for tasks like testing,


TBH, I'm not sure showing the alternative with the toolkit is a good idea here. We should definitely link to the toolkit's home page as a "next steps" scenario. But with what we already showed above, the user already "got started". There is no need to switch to the toolkit for no immediate reason.

sjrd · 2024-09-17T11:59:37Z

_overviews/getting-started/index.md

+This program is identical to the one above, with the only difference being that other toolkit libraries will also be available to use
+and their downloaded versions, instead of being specified by hand, will be the newest ones included in the toolkit.
+
+### Using REPL


Suggested change

### Using REPL

### Using the REPL

sjrd · 2024-09-17T11:59:53Z

_overviews/getting-started/index.md

+
+### Using REPL
+
+You can execute code interactively using REPL provided by the `scala` command. Execute `scala` in console without any arguments.


Suggested change

You can execute code interactively using REPL provided by the `scala` command. Execute `scala` in console without any arguments.

You can execute code interactively using the REPL provided by the `scala` command. Execute `scala` in the console without any arguments.

sjrd · 2024-09-17T12:02:28Z

_overviews/scala3-book/taste-hello-world.md

+When you run the command for the first time, two hidden directories will be created: `.bsp` and `.scala-build`. The first
+one contains the [Build Server Protocol](https://build-server-protocol.github.io/) information for IDEs, and the second one contains the results
+of compilation.


I don't think this is useful information for a user at this stage of their learning. Consider removing that paragraph.

sjrd · 2024-09-17T12:04:28Z

_overviews/tutorials/scala-for-java-programmers.md

+```
+
+The program will be automatically compiled (with compiled classes somewhere in the newly created `.scala-build` directory)
+and executed, producing a similar output:


Suggested change

and executed, producing a similar output:

and executed, producing an output similar to:

("a similar output" in English refers to another output that was previously mentioned; there is no such thing here)

bishabosha · 2024-09-17T16:38:03Z

_overviews/getting-started/index.md

-Compiling project (Scala 3.4.2, JVM (20))
-Compiled project (Scala 3.4.2, JVM (20))
+$ scala run hello.scala             
+Compiling project (Scala 3.5.0, JVM (20))


there's also a liquid variable {{site.scala-3-version}} which can automatically update when we have a new release. e.g. its used on this page in the dropdown "Testing your setup"

bishabosha · 2024-10-08T11:06:32Z

_config.yml

@@ -17,7 +17,7 @@ keywords:

 scala-version: 2.13.14
 scala-212-version: 2.12.19
-scala-3-version: 3.4.2
+scala-3-version: 3.5.1


@Gedochao updating this variable seems to be missing from the release procedure

_overviews/getting-started/index.md

Co-authored-by: Sébastien Doeraene <[email protected]>

# Conflicts: # _config.yml # api/all.md

Use scala-cli

23d6dda

bishabosha requested changes Sep 16, 2024

View reviewed changes

bishabosha reviewed Sep 16, 2024

View reviewed changes

_overviews/getting-started/index.md Outdated Show resolved Hide resolved

gkepka added 2 commits September 17, 2024 09:59

Change scala-cli to scala

0ff5ba0

Link and grammar fixes

0959275

sjrd requested changes Sep 17, 2024

View reviewed changes

bishabosha reviewed Sep 17, 2024

View reviewed changes

sjrd mentioned this pull request Sep 23, 2024

Use scala-cli for hello world example in getting started #3074

Closed

Grammar fixes + Scala 3 version update

a85e51e

bishabosha reviewed Oct 8, 2024

View reviewed changes

gkepka marked this pull request as ready for review October 9, 2024 06:27

sjrd approved these changes Oct 9, 2024

View reviewed changes

_overviews/getting-started/index.md Outdated Show resolved Hide resolved

gkepka and others added 2 commits October 16, 2024 15:12

Use toolkit 0.5.0 version

8e84db6

Co-authored-by: Sébastien Doeraene <[email protected]>

Merge branch 'main' into getting-started

57efc0e

# Conflicts: # _config.yml # api/all.md

sjrd approved these changes Oct 16, 2024

View reviewed changes

sjrd merged commit 74b36ac into scala:main Oct 16, 2024
1 check failed

gkepka mentioned this pull request Nov 18, 2024

No get started innformation #3055

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Use scala-cli in Getting Started page #3072

Use scala-cli in Getting Started page #3072

Uh oh!

gkepka commented Sep 16, 2024

Uh oh!

bishabosha left a comment •

edited

Loading

Uh oh!

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

sjrd Sep 17, 2024

Uh oh!

bishabosha Sep 17, 2024 •

edited

Loading

Uh oh!

bishabosha Oct 8, 2024

Uh oh!

Uh oh!

Uh oh!

Uh oh!

	Create a file named `hello.scala` with the following code:
	In a directory of your choice, which we will call `<project-dir>`, create a file named `hello.scala` with the following code:

	To run the program, execute `scala run hello.scala` command. The file will be compiled and executed, with console output
	To run the program, execute `scala run hello.scala` command from a terminal, within the `<project-dir>` directory. The file will be compiled and executed, with console output


		### Using REPL

		You can execute code interactively using REPL provided by the `scala` command. Execute `scala` in console without any arguments.

	and executed, producing a similar output:
	and executed, producing an output similar to:

Use scala-cli in Getting Started page #3072

Use scala-cli in Getting Started page #3072

Uh oh!

Conversation

gkepka commented Sep 16, 2024

Uh oh!

bishabosha left a comment • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

bishabosha Sep 17, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

bishabosha left a comment •

edited

Loading

bishabosha Sep 17, 2024 •

edited

Loading